docs(readme): lead with the product, not the positioning - #2027
Merged
Conversation
The README opened with abstract positioning and put the download link 87 lines down, below three benchmark charts. First-time visitors had to scroll past the concept art to find out what BitFun is or how to get it. - Lead with one concrete sentence, the app screenshot, and a download link - Move Install directly under the fold; keep source build alongside it - Condense the metrics section and keep the single-run caveat as a callout - Move roadmap positioning and the concept diagram below the fold - Add download/star badges and Discussions links for social proof and entry - Add png/og-image.png (1280x640) for the repo's social preview, which is currently unset — every shared link renders as GitHub's default grey card - Add scripts/record-demo.sh to record the demo GIF the README still needs Applies the same structure to README.zh-CN.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructures both READMEs so a first-time visitor learns what BitFun is, sees it, and can download it without scrolling. Adds the missing social preview image and a script for the demo GIF the README still needs.
No claims were changed — this is reordering, tightening, and two new assets.
Type and Areas
Type: docs
Areas: docs, repo assets
Motivation / Impact
Repo traffic over the last 14 days was 995 unique visitors, and referrers are almost entirely github.com, search engines, and our own site — there is essentially no inbound from developer communities. Before driving traffic anywhere, the landing page has to hold it. Three things were working against that:
png/og-image.png(1280x640) is added here, though applying it still needs a repo admin — Settings → General → Social preview. I only have write access.Changes:
> [!NOTE]calloutscripts/record-demo.sh— a 20-30s GIF of a real task is still the highest-impact thing missing from this page, and the script removes the fiddly parts (capture, palette encoding, GitHub's 10 MB limit)Verification
node scripts/check-repo-hygiene.mjs→ passed (5 content files scanned, 5889 filenames checked)bash -n scripts/record-demo.sh→ syntax OKpng/og-image.pngat 1280x640, 404 KB (GitHub's limit is 1 MB)Reviewer Notes
Two follow-ups this PR cannot cover, both needing repo admin:
Social preview: upload
png/og-image.pngunder Settings → General → Social previewRepo description: the current one reads
...Agent runtimeand a ready-to-use suite of desktop Agent applications.with built-in Code Agent 、 Cowork Agent、Computer Use...— two missing spaces and CJK punctuation in the English one-liner that shows up in search results and every share card. Suggested replacement:Checklist